Repository navigation
Say the environment wins over the setting and the key, not over the argument checks - #40
Merged
Merged
Conversation
…rgument checks The README said the constructor checks the opt-out variables "before anything else", but it checks its arguments first: a bad one raises ValueError even with DO_NOT_TRACK=1. Say so, and lock it in with a test. Also put the version section's first paragraph back in order: the sentence saying every event carries the version as a tag had drifted behind the argument checks added in #35 and #39, leaving its "it" pointing at the wrong thing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (posted as a plain comment rather than a formal review):
Judgment call flagged: README.md:127. The parenthetical repeats a fact the version section already states ("whether or not the client ends up enabled"). It is kept because "Turning it off" is where a reader checks precedence, and "before anything else" was the inaccurate phrase there. No do-not-auto-merge paths are touched (no workflow, This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A documentation accuracy sweep (no open issue was implementable this cycle) found two drifts in
README.md:TraceClient.__init__the argument checks (non-string values, blank required arguments, overlong version orinstall_id) run beforeenvironment_opts_out(), soDO_NOT_TRACK=1does not stopTraceClient(url, "app", 1.4, key="k")from raisingValueError. The sentence now says the environment is checked beforeenabledand the key, and that the arguments are checked before either. A test,test_arguments_are_checked_before_the_environment_opt_out, locks that order in. The existing non-string test only coveredenabled=False.version". As a result, "it" read as referring to the empty value, and the line wrapping was ragged. The paragraph is split in two: the tagging behaviour comes first, then the validation rules. No wording about behaviour changed.No production code changed. No Java-visible behaviour changed, so trace-client-java needs no matching change.
Skipped issues
MAX_TAGS) is still deferred. It needs an owner decision on the README's "tagsalways holds at leastversion" promise at the cap, and a coordinated change in trace-client-java, as recorded on the issue.Test plan
python3 -m unittest: 77 tests run, OK (local, Python 3.8)test (3.8),test (3.10),test (3.12)greenNo tracking issue. The gap was found during a documentation sweep.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson